<?php

/**
 * Zend Framework
 *
 * LICENSE
 *
 * This source file is subject to the new BSD license that is bundled
 * with this package in the file LICENSE.txt.
 * It is also available through the world-wide-web at this URL:
 * http://framework.zend.com/license/new-bsd
 * If you did not receive a copy of the license and are unable to
 * obtain it through the world-wide-web, please send an email
 * to license@zend.com so we can send you a copy immediately.
 *
 * @category   Zend
 * @package    Zend_Gdata
 * @subpackage Calendar
 * @copyright  Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)
 * @license    http://framework.zend.com/license/new-bsd     New BSD License
 * @version    $Id: Color.php 23775 2011-03-01 17:25:24Z ralph $
 */

/**
 * @see Zend_Gdata_Extension
 */
require_once 'Zend/Gdata/Extension.php';

/**
 * Represents the gCal:color element used by the Calendar data API
 * to define the color of a calendar in the UI.
 *
 * @category   Zend
 * @package    Zend_Gdata
 * @subpackage Calendar
 * @copyright  Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)
 * @license    http://framework.zend.com/license/new-bsd     New BSD License
 */
class Zend_Gdata_Calendar_Extension_Color extends Zend_Gdata_Extension {
	
	protected $_rootNamespace = 'gCal';
	protected $_rootElement = 'color';
	protected $_value = null;
	
	/**
	 * Constructs a new Zend_Gdata_Calendar_Extension_Color object.
	 * @param string $value (optional) The text content of the element.
	 */
	public function __construct($value = null) {
		$this->registerAllNamespaces ( Zend_Gdata_Calendar::$namespaces );
		parent::__construct ();
		$this->_value = $value;
	}
	
	/**
	 * Retrieves a DOMElement which corresponds to this element and all
	 * child properties.  This is used to build an entry back into a DOM
	 * and eventually XML text for sending to the server upon updates, or
	 * for application storage/persistence.
	 *
	 * @param DOMDocument $doc The DOMDocument used to construct DOMElements
	 * @return DOMElement The DOMElement representing this element and all
	 * child properties.
	 */
	public function getDOM($doc = null, $majorVersion = 1, $minorVersion = null) {
		$element = parent::getDOM ( $doc, $majorVersion, $minorVersion );
		if ($this->_value != null) {
			$element->setAttribute ( 'value', $this->_value );
		}
		return $element;
	}
	
	/**
	 * Given a DOMNode representing an attribute, tries to map the data into
	 * instance members.  If no mapping is defined, the name and value are
	 * stored in an array.
	 *
	 * @param DOMNode $attribute The DOMNode attribute needed to be handled
	 */
	protected function takeAttributeFromDOM($attribute) {
		switch ($attribute->localName) {
			case 'value' :
				$this->_value = $attribute->nodeValue;
				break;
			default :
				parent::takeAttributeFromDOM ( $attribute );
		}
	}
	
	/**
	 * Get the value for this element's value attribute.
	 *
	 * @return string The value associated with this attribute.
	 */
	public function getValue() {
		return $this->_value;
	}
	
	/**
	 * Set the value for this element's value attribute.
	 *
	 * @param string $value The desired value for this attribute.
	 * @return Zend_Gdata_Calendar_Extension_Color The element being modified.
	 */
	public function setValue($value) {
		$this->_value = $value;
		return $this;
	}
	
	/**
	 * Magic toString method allows using this directly via echo
	 * Works best in PHP >= 4.2.0
	 */
	public function __toString() {
		return $this->_value;
	}

}
